/*
 * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package java.lang;
import java.lang.ref.*;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Supplier;

/**
 * This class provides thread-local variables.  These variables differ from
 * their normal counterparts in that each thread that accesses one (via its
 * {@code get} or {@code set} method) has its own, independently initialized
 * copy of the variable.  {@code ThreadLocal} instances are typically private
 * static fields in classes that wish to associate state with a thread (e.g.,
 * a user ID or Transaction ID).
 *
 * <p>For example, the class below generates unique identifiers local to each
 * thread.
 * A thread's id is assigned the first time it invokes {@code ThreadId.get()}
 * and remains unchanged on subsequent calls.
 * <pre>
 * import java.util.concurrent.atomic.AtomicInteger;
 *
 * public class ThreadId {
 *     // Atomic integer containing the next thread ID to be assigned
 *     private static final AtomicInteger nextId = new AtomicInteger(0);
 *
 *     // Thread local variable containing each thread's ID
 *     private static final ThreadLocal&lt;Integer&gt; threadId =
 *         new ThreadLocal&lt;Integer&gt;() {
 *             &#64;Override protected Integer initialValue() {
 *                 return nextId.getAndIncrement();
 *         }
 *     };
 *
 *     // Returns the current thread's unique ID, assigning it if necessary
 *     public static int get() {
 *         return threadId.get();
 *     }
 * }
 * </pre>
 * <p>Each thread holds an implicit reference to its copy of a thread-local
 * variable as long as the thread is alive and the {@code ThreadLocal}
 * instance is accessible; after a thread goes away, all of its copies of
 * thread-local instances are subject to garbage collection (unless other
 * references to these copies exist).
 *
 * @author  Josh Bloch and Doug Lea
 * @since   1.2
 */
public class ThreadLocal<T> {
    /**
     * ThreadLocals rely on per-thread linear-probe hash maps attached
     * to each thread (Thread.threadLocals and
     * inheritableThreadLocals).  The ThreadLocal objects act as keys,
     * searched via threadLocalHashCode.  This is a custom hash code
     * (useful only within ThreadLocalMaps) that eliminates collisions
     * in the common case where consecutively constructed ThreadLocals
     * are used by the same threads, while remaining well-behaved in
     * less common cases.
     * 线程获取 threadLocal.get()时，如果是第一次在某个 threadLocal对象上 get()时  会给当前线程分配一个value
     * 这个value 和当前 threadLocal 对象，会被封装成一个 entry，其中 key是  threadLocal对象  value是threadLocal对象给当前线程生成的value
     * 这个 entry 存放到 当前线程 threadLocals 这个 map的那个 桶位  是由 threadLocal对象的  threadLocalHashCode决定的
     * 存放的时候   使用  threadLocalHashCode & ( table.length - 1 ) 得到的位置  就是当前 entry需要存放的位置
     */
    private final int threadLocalHashCode = nextHashCode();

    /**
     * The next hash code to be given out. Updated atomically. Starts at
     * zero.
     * 创建 threadLocal对象时  会使用到
     * 每创建一个 对象  都会使用 nextHashCode 分配一个 hash值给创建的对象
     */
    private static AtomicInteger nextHashCode =
        new AtomicInteger();

    /**
     * The difference between successively generated hash codes - turns
     * implicit sequential thread-local IDs into near-optimally spread
     * multiplicative hash values for power-of-two-sized tables.
     * 每创建一个 threadLocal对象  这个   ThreadLocal.nextHashCode  就会增长 0x61c88647
     * 这个值很特殊   他是  斐波那契数   也叫黄金分割数。使用 hash增量为这个数值  可以使得  hash分布非常均匀
     */
    private static final int HASH_INCREMENT = 0x61c88647;

    /**
     * Returns the next hash code.
     * 给当前创建  新的 threadLocal对象时   会给这个对象分配一个  hash值  通过这个方法
     */
    private static int nextHashCode() {
        return nextHashCode.getAndAdd(HASH_INCREMENT);
    }

    /**
     * Returns the current thread's "initial value" for this
     * thread-local variable.  This method will be invoked the first
     * time a thread accesses the variable with the {@link #get}
     * method, unless the thread previously invoked the {@link #set}
     * method, in which case the {@code initialValue} method will not
     * be invoked for the thread.  Normally, this method is invoked at
     * most once per thread, but it may be invoked again in case of
     * subsequent invocations of {@link #remove} followed by {@link #get}.
     *
     * <p>This implementation simply returns {@code null}; if the
     * programmer desires thread-local variables to have an initial
     * value other than {@code null}, {@code ThreadLocal} must be
     * subclassed, and this method overridden.  Typically, an
     * anonymous inner class will be used.
     *
     * @return the initial value for this thread-local
     *
     * 默认返回null   但是一般情况下 都需要重写
     * 是用于初始化值的方法
     */
    protected T initialValue() {
        return null;
    }

    /**
     * Creates a thread local variable. The initial value of the variable is
     * determined by invoking the {@code get} method on the {@code Supplier}.
     *
     * @param <S> the type of the thread local's value
     * @param supplier the supplier to be used to determine the initial value
     * @return a new thread local variable
     * @throws NullPointerException if the specified supplier is null
     * @since 1.8
     */
    public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier) {
        return new SuppliedThreadLocal<>(supplier);
    }

    /**
     * Creates a thread local variable.
     * @see #withInitial(java.util.function.Supplier)
     */
    public ThreadLocal() {
    }

    /**
     * Returns the value in the current thread's copy of this
     * thread-local variable.  If the variable has no value for the
     * current thread, it is first initialized to the value returned
     * by an invocation of the {@link #initialValue} method.
     *
     * @return the current thread's value of this thread-local
     *
     * 返回当前线程与当前 threadLocal对象  相关联的  线程局部变量，这个变量只有当前线程可以访问到
     * 如果当前线程 没有分配  则给当前线程去分配(通过 initialValue 这个方法)
     */
    public T get() {
        //获取当前线程
        Thread t = Thread.currentThread();
        //获取当前线程中的  threadLocalMap
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            //条件成立  当前线程 已经初始化过 threadLocalMap；  拥有自己的 threadLocalMap对象了

            //key： 当前 threadLocal对象
            //调用 map.getEntry  获取该  threadLocalMap中  当前threadLocal对象 所关联的  entry
            ThreadLocalMap.Entry e = map.getEntry(this);

            //条件成立  说明当前线程初始化过  与当前threadLocal对象想关联的  线程局部变量
            if (e != null) {
                //返回 对应的value
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        //执行到这里的情况：
        //1、当前线程 对应的 threadLocalMap 为空
        //2、当前threadLocal对象 没有初始化过  也就是没有生成过 相关联的  线程局部变量

        //初始化当前线程相关联的  threadLocalMap  以及  当前 线程与threadLocal相关联的 value
        return setInitialValue();
    }

    /**
     * Variant of set() to establish initialValue. Used instead
     * of set() in case user has overridden the set() method.
     *
     * @return the initial value
     * 初始化当前线程相关联的  threadLocalMap  以及  当前 线程与threadLocal相关联的 value
     */
    private T setInitialValue() {
        //通过初始化方法  获取初始化值
        T value = initialValue();
        //获取当前线程 引用
        Thread t = Thread.currentThread();
        //获取 当前线程 所 关联的  threadLocalMap 对象
        ThreadLocalMap map = getMap(t);

        //map对象不为空  往map里面set数据
        if (map != null)
            map.set(this, value);
        //map对象为空  初始化map  并set数据
        else
            createMap(t, value);
        return value;
    }

    /**
     * Sets the current thread's copy of this thread-local variable
     * to the specified value.  Most subclasses will have no need to
     * override this method, relying solely on the {@link #initialValue}
     * method to set the values of thread-locals.
     *
     * @param value the value to be stored in the current thread's copy of
     *        this thread-local.
     * 修改或设置 当前线程 与 当前 threadLocal 对象 关联的 线程局部变量
     */
    public void set(T value) {
        //获取当前线程
        Thread t = Thread.currentThread();
        //获取当前线程中的  threadLocalMap对象
        ThreadLocalMap map = getMap(t);
        //map 不为 空  可以直接set
        if (map != null)
            map.set(this, value);
        //map 为空  初始化后set
        else
            createMap(t, value);
    }

    /**
     * Removes the current thread's value for this thread-local
     * variable.  If this thread-local variable is subsequently
     * {@linkplain #get read} by the current thread, its value will be
     * reinitialized by invoking its {@link #initialValue} method,
     * unless its value is {@linkplain #set set} by the current thread
     * in the interim.  This may result in multiple invocations of the
     * {@code initialValue} method in the current thread.
     *
     * @since 1.5
     * 把当前 threadLocal 从 线程中移除掉
     */
     public void remove() {
         //获取当前线程 所对应的  threadLocalMap 对象
         ThreadLocalMap m = getMap(Thread.currentThread());
         if (m != null)
             //条件成立  map对象已经初始化了
             //把 当前 threadLocal对象  对应的 value 删除
             m.remove(this);
     }

    /**
     * Get the map associated with a ThreadLocal. Overridden in
     * InheritableThreadLocal.
     *
     * @param  t the current thread
     * @return the map
     *
     * 获取当前线程 Thread对象的  threadLocals  这个map引用
     */
    ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

    /**
     * Create the map associated with a ThreadLocal. Overridden in
     * InheritableThreadLocal.
     *
     * @param t the current thread
     * @param firstValue value for the initial entry of the map
     *
     * 初始化 当线程对应的 threadLocals的map 并设置第一个值
     */
    void createMap(Thread t, T firstValue) {
        //参数 t 就是为了 要访问当前这个线程 t.threadLocals  字段 并进行初始化
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

    /**
     * Factory method to create map of inherited thread locals.
     * Designed to be called only from Thread constructor.
     *
     * @param  parentMap the map associated with parent thread
     * @return a map containing the parent's inheritable bindings
     */
    static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
        return new ThreadLocalMap(parentMap);
    }

    /**
     * Method childValue is visibly defined in subclass
     * InheritableThreadLocal, but is internally defined here for the
     * sake of providing createInheritedMap factory method without
     * needing to subclass the map class in InheritableThreadLocal.
     * This technique is preferable to the alternative of embedding
     * instanceof tests in methods.
     */
    T childValue(T parentValue) {
        throw new UnsupportedOperationException();
    }

    /**
     * An extension of ThreadLocal that obtains its initial value from
     * the specified {@code Supplier}.
     */
    static final class SuppliedThreadLocal<T> extends ThreadLocal<T> {

        private final Supplier<? extends T> supplier;

        SuppliedThreadLocal(Supplier<? extends T> supplier) {
            this.supplier = Objects.requireNonNull(supplier);
        }

        @Override
        protected T initialValue() {
            return supplier.get();
        }
    }

    /**
     * ThreadLocalMap is a customized hash map suitable only for
     * maintaining thread local values. No operations are exported
     * outside of the ThreadLocal class. The class is package private to
     * allow declaration of fields in class Thread.  To help deal with
     * very large and long-lived usages, the hash table entries use
     * WeakReferences for keys. However, since reference queues are not
     * used, stale entries are guaranteed to be removed only when
     * the table starts running out of space.
     *
     * ThreadLocalMap 是一个定制的 hashmap 只适合用于维护 线程对应ThreadLocal的值  此类的方法没有在 ThreadLocal 类外部暴漏
     * 这个类  是私有的  允许在 Thread中以字段的形式声明   以助于处理存储量大，生命周期长的使用用途
     * 此类的 key使用 弱引用 WeakReference
     * 但是  一旦 引用不在被使用，只有当hash表中 空间被耗尽的时候，  对应不再使用的键值对实体才会被回收
     *
     */
    static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference, using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced, so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         * 什么是弱引用？
         * A a = new A();  //强引用
         * WeakReference b = new WeakReference(a);   //弱引用
         *
         * 当 a = null的时候
         * 下一次GC 会回收对象a，而弱引用并不会影响GC回收，并且在 b 进行get的时候，会返回null
         *
         * key使用的是 弱引用  保存 threadLocal对象
         * value 使用的是强引用   保存 threadLocal对象与  当前线程相关联的  value
         *
         * entry中的key  这样设计有什么好处呢?
         * 当threadLocal对象失去强引用并且被GC回收之后，散列表中 与 threadLocal对象相关联的 entry.key 再次去key.get()的时候  拿到的是null
         * 站在 map的角度 就可以区分那些entry是过期的  那些entry是没有过期的
         *
         */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }

        /**
         * The initial capacity -- MUST be a power of two.
         * 初始化当前 map内部 散列表数组的长度
         */
        private static final int INITIAL_CAPACITY = 16;

        /**
         * The table, resized as necessary.
         * table.length MUST always be a power of two.
         * threadLocalMap 内部散列表数组引用  数组长度必须是2的次方数
         */
        private Entry[] table;

        /**
         * The number of entries in the table.
         * 散列表中的  entry数量
         */
        private int size = 0;

        /**
         * The next size value at which to resize.
         * 扩容触发阈值  初始值为 len * 2 / 3
         * 触发后 调用 rehash方法
         * rehash方法，先做一次全量检查  全局的过期数据，把散列表中 过期的 entry移除
         * 如果移除之后，当前散列表中的 entry 个数任然达到  threshold - threshold/4   然后才进行扩容
         */
        private int threshold; // Default to 0

        /**
         * Set the resize threshold to maintain at worst a 2/3 load factor.
         * 设置当前  扩容阈值
         * 设置为  当前数组长度的   2/3
         */
        private void setThreshold(int len) {
            threshold = len * 2 / 3;
        }

        /**
         * Increment i modulo len.
         * i  当前下标
         * len   当前散列表长度
         * 获取下一个下标(每次+1)  如果超过最大长度  返回0
         */
        private static int nextIndex(int i, int len) {
            return ((i + 1 < len) ? i + 1 : 0);
        }

        /**
         * Decrement i modulo len.
         * i  当前下标
         * len   当前散列表长度
         * 获取前一个下标(每次-1)  如果-1小于0  则返回 len-1
         */
        private static int prevIndex(int i, int len) {
            return ((i - 1 >= 0) ? i - 1 : len - 1);
        }

            /**
         * Construct a new map initially containing (firstKey, firstValue).
         * ThreadLocalMaps are constructed lazily, so we only create
         * one when we have at least one entry to put in it.
         *
         * thread.threadLocals 字段是延迟初始化的   只有线程第一次  存储 threadLocal-value的时候 才会创建 ThreadLocalMap 对象
         *
         * firstKey threadLocal对象
         * firstValue  当前线程 与 threadLocal对象 关联的 value
         */
        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            //创建 entry数组(散列表)  长度为 默认的16
            table = new Entry[INITIAL_CAPACITY];

            //寻址算法：  key.threadLocalHashCode & （散列表长度 - 1）
            //由于 散列表的长度  一定是 2的次方数  16=>1 0000    15=>1111
            //1111 与任何数进行 & 运算  结果一定是  小于等于 1111的   也是一种快速取余的方式(hashMap concurrentHashMap中同理)
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);

            //创建 entry对象设置值之后 并放到 散列表中的指定位置
            table[i] = new Entry(firstKey, firstValue);
            //设置 size为1   初始化的时候  只有一个entry进来
            size = 1;
            //设置扩容阈值
            setThreshold(INITIAL_CAPACITY);
        }

        /**
         * Construct a new map including all Inheritable ThreadLocals
         * from given parent map. Called only by createInheritedMap.
         *
         * @param parentMap the map associated with parent thread.
         */
        private ThreadLocalMap(ThreadLocalMap parentMap) {
            Entry[] parentTable = parentMap.table;
            int len = parentTable.length;
            setThreshold(len);
            table = new Entry[len];

            for (int j = 0; j < len; j++) {
                Entry e = parentTable[j];
                if (e != null) {
                    @SuppressWarnings("unchecked")
                    ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
                    if (key != null) {
                        Object value = key.childValue(e.value);
                        Entry c = new Entry(key, value);
                        int h = key.threadLocalHashCode & (len - 1);
                        while (table[h] != null)
                            h = nextIndex(h, len);
                        table[h] = c;
                        size++;
                    }
                }
            }
        }

        /**
         * Get the entry associated with key.  This method
         * itself handles only the fast path: a direct hit of existing
         * key. It otherwise relays to getEntryAfterMiss.  This is
         * designed to maximize performance for direct hits, in part
         * by making this method readily inlinable.
         *
         * @param  key the thread local object
         * @return the entry associated with key, or null if no such
         *
         * threadLocal对象的 get方法  其实是由  threadLocalMap的getEntry方法  代理操作的
         * key   某个 threadLocal对象
         */
        private Entry getEntry(ThreadLocal<?> key) {
            //根据 threadLocal对象的  threadLocalHashCode   计算其应该存放的 桶位
            int i = key.threadLocalHashCode & (table.length - 1);
            //获取  目标桶位的  entry对象
            Entry e = table[i];
            if (e != null && e.get() == key)
                //条件成立  表示 entry不为空   并且相同
                //隐含的意思是   threadLocal对象没有被回收  并且这个桶位存放的key相同
                //这个时候  直接把 e返回给上层即可
                return e;
            else
                //执行到这里的几种情况：
                //1、e == null  一般这个时候是 threadLocal对象被回收了(正常情况下很难出现  因为能把 key 传进来就代表没有被回收)
                //2、e.get() != key  表示当前桶位的 key 与当前 threadLocal对象不相同

                //getEntryAfterMiss 会继续向当前桶位 后面 搜索 e.key == key的 entry
                //为什么要这样做呢？
                //因为存储时 发生hash冲突之后 不会在 entry层面生成 链表去存储 ， 而是线性向后找到一个  可以使用的 桶位  并且存放进去
                return getEntryAfterMiss(key, i, e);
        }

        /**
         * Version of getEntry method for use when key is not found in
         * its direct hash slot.
         *
         * @param  key the thread local object
         * @param  i the table index for key's hash code
         * @param  e the entry at table[i]
         * @return the entry associated with key, or null if no such
         *
         * key   threadLocal对象  表示key
         * i   表示当前 key  计算出来的 index桶位
         * e   table[i]  中的entry
         * 查询的到返回 查询到的  查询不到  返回null
         *
         */
        private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
            //获取 当前散列表
            Entry[] tab = table;
            //获取当前散列表的长度
            int len = tab.length;

            //条件 e != null  表示向后查找的范围是有限的  遇到  e == null的时候 就停止查找了
            while (e != null) {
                //获取当前 e对应的  threadLocal对象
                ThreadLocal<?> k = e.get();

                //条件成立表示 查询到了目标  可以直接返回
                if (k == key)
                    return e;

                //条件成立 threadLocal对象为空  表示该对象被回收了或 因为 key是弱引用
                if (k == null)
                    //做一次  探测式的过期数据回收
                    expungeStaleEntry(i);
                else
                    //条件成立 threadLocal对象不为空
                    //获取当前 entry 的下一个下标  更新 index 继续向后搜索
                    i = nextIndex(i, len);
                //获取下一个  桶位中的  entry
                e = tab[i];
            }
            //执行到这里  表示 关联区段内都没有找到相应数据  返回 null
            return null;
        }

        /**
         * Set the value associated with key.
         *
         * @param key the thread local object
         * @param value the value to be set
         *
         * threadLocal 使用set方法 给当前线程 添加 threadLocal-value  键值对
         */
        private void set(ThreadLocal<?> key, Object value) {

            // We don't use a fast path as with get() because it is at
            // least as common to use set() to create new entries as
            // it is to replace existing ones, in which case, a fast
            // path would fail more often than not.

            //获取当前散列表
            Entry[] tab = table;
            //获取当前散列表的长度
            int len = tab.length;
            //路由寻址 查询目标 桶为下标
            int i = key.threadLocalHashCode & (len-1);

            //条件：
            //当前 下标对应的 entry不为 null
            //遍历方式：
            //获取当前下标的 下一个
            //初始条件：
            //对应的下标

            //循环查找出一个可以使用的 桶位，  那么什么时候可以使用呢？
            //1、k == key  走 value的替换
            //2、遇到一个过期的 桶位  这个时候可以占用替换
            //3、找到到一个 为 null的  桶位
            for (Entry e = tab[i];
                 e != null;
                 e = tab[i = nextIndex(i, len)]) {

                //获取当前 entry对应的 threadLocal对象
                ThreadLocal<?> k = e.get();

                //当前桶位的 key与 当前 threadLocal相同
                //说明这是  修改操作
                if (k == key) {
                    //更换 value值  直接返回
                    e.value = value;
                    return;
                }

                //key 为null 表示这个桶为的  threadLocal对象已经被回收了  当前 entry是过期数据
                if (k == null) {
                    //遍历遇到了一个  过期的数据
                    //走替换过期数据的逻辑
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }

            //查询到了一个 为空的 桶位， 创建一个新的 entry设置进去
            tab[i] = new Entry(key, value);
            int sz = ++size;
            //条件1成立：  表示启发式清理没有清理到任何数据
            //条件2成立：  表示 当前散列表中的元素  已经达到扩容阈值了   会触发一个 rehash操作
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

        /**
         * Remove the entry for key.
         * 根据key删除 entry中的数据
         */
        private void remove(ThreadLocal<?> key) {
            //获取当前散列表
            Entry[] tab = table;
            //获取当前散列表长度
            int len = tab.length;
            //计算 正确位置
            int i = key.threadLocalHashCode & (len-1);
            //以正确位置 为下标开始 遍历 散列表
            //直到  桶位下标位 null
            //每次 探测式清理  会把整个threadLocalMap中的数据 进行收缩
            //所以不会出现  数据发生偏移之后  正确位置与偏移位置之间存在 null的情况
            for (Entry e = tab[i];
                 e != null;
                 e = tab[i = nextIndex(i, len)]) {
                //条件成立  表示找到了对用的 entry
                if (e.get() == key) {
                    //清除弱引用
                    e.clear();
                    //探测式 清理当前桶位数据
                    expungeStaleEntry(i);
                    return;
                }
            }
        }

        /**
         * Replace a stale entry encountered during a set operation
         * with an entry for the specified key.  The value passed in
         * the value parameter is stored in the entry, whether or not
         * an entry already exists for the specified key.
         *
         * As a side effect, this method expunges all stale entries in the
         * "run" containing the stale entry.  (A run is a sequence of entries
         * between two null slots.)
         *
         * @param  key the key
         * @param  value the value to be associated with key
         * @param  staleSlot index of the first stale entry encountered while
         *         searching for key.
         *
         * set过程中遇到了过期数据   需要替换过期数据
         * key   entry对应的 threadLocal对象
         * value   entry对应的  value值
         * staleSlot   需要替换的桶位下标  也就是过期数据的下标
         */
        private void replaceStaleEntry(ThreadLocal<?> key, Object value,
                                       int staleSlot) {
            //获取散列表
            Entry[] tab = table;
            //获取散列表长度
            int len = tab.length;
            Entry e;

            // Back up to check for prior stale entry in current run.
            // We clean out whole runs at a time to avoid continual
            // incremental rehashing due to garbage collector freeing
            // up refs in bunches (i.e., whenever the collector runs).

            //表示 开始清理过期数据的  开始下标  默认值为  staleSlot
            int slotToExpunge = staleSlot;

            //从staleSlot的上一个 开始向前遍历  查找过期数据  直到遍历到的桶位为null
            for (int i = prevIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = prevIndex(i, len))
                //条件成立  当前桶位的 key为null  也就是 threadLocal为null 表示找到了过期数据
                if (e.get() == null)
                    //设置 过期下标 为i
                    slotToExpunge = i;

            // Find either the key or trailing null slot of run, whichever
            // occurs first

            //以当前过期位置staleSlot的下一个开始  向后查找 直到遍历到的桶位为null
            for (int i = nextIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = nextIndex(i, len)) {

                //获取当前entry的  key
                ThreadLocal<?> k = e.get();

                // If we find key, then we need to swap it
                // with the stale entry to maintain hash table order.
                // The newly stale slot, or any other stale slot
                // encountered above it, can then be sent to expungeStaleEntry
                // to remove or rehash all of the other entries in run.


                //条件成立  需要走替换逻辑
                //因为这个桶位并不是 那个过期数据的桶位 ,且 当前桶位的key与  期望插入的key相同
                if (k == key) {
                    //value替换
                    e.value = value;

                    //因为  正确的桶位是  过期的数据，这个时候连同之前的数据做了一次替换
                    //然后迁移到  正确桶位上
                    tab[i] = tab[staleSlot];
                    tab[staleSlot] = e;

                    // Start expunge at preceding stale entry if it exists

                    //条件成立：
                    //1、说明 刚开始的向前查找过期数据  并没有找到过期的  entry
                    //2、向后检查过程中也没有发现过期数据
                    if (slotToExpunge == staleSlot)
                        //修改为  当前循环的位置
                        slotToExpunge = i;

                    cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
                    return;
                }

                // If we didn't find stale entry on backward scan, the
                // first stale entry seen while scanning for key is the
                // first still present in the run.

                //条件1： k == null  成立表示  当前遍历到的  entry是一个过期数据
                //条件2： slotToExpunge == staleSlot  成立表示  刚开始的向前查找过期数据  并没有找到过期的  entry
                if (k == null && slotToExpunge == staleSlot)
                    //因为向后 查询的过程中找到了 一个过期数据  更新为当前位置
                    //前提是  向前扫描的时候未发现过期数据
                    slotToExpunge = i;
            }

            // If key not found, put new entry in stale slot

            //执行到这里的情况：
            //向后查找的时候  没有发现   k==key的 entry  说明当前是一个 set操作

            //清空过期数据
            tab[staleSlot].value = null;
            //set 新数据到  entry中
            tab[staleSlot] = new Entry(key, value);

            // If there are any other stale entries in run, expunge them
            //条件成立：  除了staleSlot  以外还有其他 过期的 entry  所以需要开启清理数据的逻辑
            if (slotToExpunge != staleSlot)
                cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
        }

        /**
         * Expunge a stale entry by rehashing any possibly colliding entries
         * lying between staleSlot and the next null slot.  This also expunges
         * any other stale entries encountered before the trailing null.  See
         * Knuth, Section 6.4
         *
         * @param staleSlot index of slot known to have null key
         * @return the index of the next null slot after staleSlot
         * (all between staleSlot and this slot will have been checked
         * for expunging).
         *
         * 探测式  过期数据回收
         * staleSlot  table[staleSlot]就是一个过期数据  以这个位置开始继续向后查找数据
         * 直到 桶位 为 null
         */
        private int expungeStaleEntry(int staleSlot) {
            //获取当前散列表
            Entry[] tab = table;
            //获取当前散列表的长度
            int len = tab.length;

            // expunge entry at staleSlot

            //只有 key为null的时候  才会来到这个方法
            //这里对  被回收的桶位  进行回收
            //设置 value 为null
            tab[staleSlot].value = null;
            //设置 整个 桶位 为null
            tab[staleSlot] = null;
            //size 减少表示移除了一个数据
            size--;

            // Rehash until we encounter null

            //表示 当前遍历到的 桶位 对应的 entry对象
            Entry e;
            //表示当前 遍历到的 下标
            int i;

            //for循环条件：
            //(e = tab[i]) != null   当前 桶位对应的 entry对象不为 null
            //初始值：
            //i = nextIndex(staleSlot, len)   获取传入 staleSlot的下一个下标
            //遍历条件：
            //i = nextIndex(i, len)  获取i后面的下一个  下标
            for (i = nextIndex(staleSlot, len);
                 (e = tab[i]) != null;
                 i = nextIndex(i, len)) {
                //获取 当前遍历到 桶位对应的  threadLocal对象
                ThreadLocal<?> k = e.get();

                //条件成立  当前  threadLocal对象为null  表示该对象已经被回收  需要清空entry
                if (k == null) {
                    //目标 桶位清空
                    e.value = null;
                    tab[i] = null;
                    size--;
                } else {
                    //执行到这里  表示当前 桶对应的 entry  的key 不为空
                    //也就是 threadLocal对象不为空  没有被回收
                    //但是前面可能清理了几个过期数据，而当前 entry存储的时候  又发生了偏移，这个时候就需要优化存储位置以提高查询效率
                    //这个时候 会优化这个位置  让他尽可能的靠近 正确位置


                    //计算 当前 threadLocal对应的 桶位
                    int h = k.threadLocalHashCode & (len - 1);

                    //条件成立   threadLocal 当前桶位不是其目标桶位，需要更换桶位
                    if (h != i) {
                        //设置当前桶位 位null
                        tab[i] = null;

                        // Unlike Knuth 6.4 Algorithm R, we must scan until
                        // null because multiple entries could have been stale.

                        //从 h开始 遍历散列表 直到找到  第一个为null的  桶位
                        while (tab[h] != null)
                            h = nextIndex(h, len);
                        //把当前 threadLocal对应的 entry设置进去  这个位置是进行优化之后(可能是)更近的位置
                        tab[h] = e;
                    }
                }
            }
            //返回i   i对应的目标桶位 一定是 null
            return i;
        }

        /**
         * Heuristically scan some cells looking for stale entries.
         * This is invoked when either a new element is added, or
         * another stale one has been expunged. It performs a
         * logarithmic number of scans, as a balance between no
         * scanning (fast but retains garbage) and a number of scans
         * proportional to number of elements, that would find all
         * garbage but would cause some insertions to take O(n) time.
         *
         * @param i a position known NOT to hold a stale entry. The
         * scan starts at the element after i.
         *
         * @param n scan control: {@code log2(n)} cells are scanned,
         * unless a stale entry is found, in which case
         * {@code log2(table.length)-1} additional cells are scanned.
         * When called from insertions, this parameter is the number
         * of elements, but when from replaceStaleEntry, it is the
         * table length. (Note: all this could be changed to be either
         * more or less aggressive by weighting n instead of just
         * using straight log n. But this version is simple, fast, and
         * seems to work well.)
         *
         * @return true if any stale entries have been removed.
         *
         * 启发式清理
         * i      开始的位置
         * n      一般传递的是散列表的长度  ，也表示结束条件
         */
        private boolean cleanSomeSlots(int i, int n) {
            //表示  启发式清理工作  是否清理过过期数据
            boolean removed = false;
            //获取当前散列表
            Entry[] tab = table;
            //获取当前散列表的长度
            int len = tab.length;
            do {

                //获取开始位置的下一个位置
                //因为不从i开始检查处理呢？SynchronousQueue
                //因为传入的i一定是  不需要清理的位置
                //从调用的地方来看
                //一个是  set的时候  会把set进去值的地方传入，进行启发式清理
                //另外的则是  会使用expungeStaleEntry方法的返回值  这个方法的返回值的目标桶位一定是null
                //综上  所以i虽然是开始的位置，但是这个桶位是不需要进行处理的
                i = nextIndex(i, len);

                //获取下一个位置的 entry对象
                Entry e = tab[i];

                //条件成立：
                //当前桶位 entry不为空  并且  key为空
                //表示 当前桶位的数据  是过期数据需要清理
                if (e != null && e.get() == null) {
                    //重新更新n位数组长度
                    n = len;
                    //表示清理过数据
                    removed = true;
                    //采用探测式清理  清理过该桶位  及该桶位后面的桶位
                    //i的返回值  是一个 为null的 桶位  并且  会发生变化
                    //探测式清理  会根据i往后面找，并返回一个后面的桶位下标
                    i = expungeStaleEntry(i);
                }

                //假设  table长度是  16   16=> 1 0000
                //那么  16 >>>= 1  等于  1000
                //1000 >>>= 1  等于  0100
                //0100 >>>= 1  等于  0010
                //0010 >>>= 1  等于  0001
                //0001 >>>= 1  等于  0000
                //也就是相当于会 执行5次循环  如果一直没有找到需要清理的数据
                //如果找到需要清理的数据  那么就会 重置n为 数组长度
            } while ( (n >>>= 1) != 0);
            return removed;
        }

        /**
         * Re-pack and/or re-size the table. First scan the entire
         * table removing stale entries. If this doesn't sufficiently
         * shrink the size of the table, double the table size.
         * 进行一次全量的探测式清理  如果清理之后还需要扩容，那么会触发扩容
         *
         */
        private void rehash() {
            //进行一次全量的  探测式清理工作
            //这个方法执行完成之后   当前散列表中  所有过期的数据都会被清理
            expungeStaleEntries();

            // Use lower threshold for doubling to avoid hysteresis
            // 条件成立   表示清理完过期数据后   当前散列表内的 entry数量任然达到了扩容阈值
            if (size >= threshold - threshold / 4)
                resize();
        }

        /**
         * Double the capacity of the table.
         * 扩容方法
         */
        private void resize() {
            //表示当前散列表
            Entry[] oldTab = table;
            //当前散列表长度
            int oldLen = oldTab.length;
            //新散列表长度是  老的散列表长度的两倍
            int newLen = oldLen * 2;
            //创建一个  2倍长度的散列表
            Entry[] newTab = new Entry[newLen];
            //重新计算 新散列表中 有多少有效的数据
            int count = 0;

            //遍历 当前散列表  也就是旧的散列表把 数据填充到新的散列表中
            for (int j = 0; j < oldLen; ++j) {
                //获取当前遍历到的 entry对象
                Entry e = oldTab[j];
                //条件成立  表示当前桶位 有数据 需要处理
                if (e != null) {
                    //获取当前 key
                    ThreadLocal<?> k = e.get();
                    //当前 key为null 表示当前 threadLocal对象被回收了  是一个过期数据
                    if (k == null) {
                        //清空  强引用  帮助回收
                        e.value = null; // Help the GC
                    } else {
                        //条件成立  表示当前 entry需要 进行迁移

                        //计算 新hash表中的桶位下标
                        int h = k.threadLocalHashCode & (newLen - 1);

                        //遍历新的散列表找到一个 桶位为 null的 下标
                        //如果正确位置 有数据 那么就  向后查询  可以存放的下标
                        while (newTab[h] != null)
                            h = nextIndex(h, newLen);

                        //把entry设置到新的 散列表中 进行了迁移
                        newTab[h] = e;
                        count++;
                    }
                }
            }
            //设置新表的扩容阈值
            setThreshold(newLen);
            size = count;
            //替换散列表引用
            table = newTab;
        }

        /**
         * Expunge all stale entries in the table.
         * 遍历所有的桶位进行一次探测式清理
         */
        private void expungeStaleEntries() {
            //获取当前散列表
            Entry[] tab = table;
            //获取当前散列表长度
            int len = tab.length;
            //遍历当前散列表
            for (int j = 0; j < len; j++) {
                Entry e = tab[j];
                //条件成立  表示当前桶位  是过期数需要清理
                if (e != null && e.get() == null)
                    //探测式 清理过期数据
                    expungeStaleEntry(j);
            }
        }
    }
}
